home *** CD-ROM | disk | FTP | other *** search
/ Aminet 1 (Walnut Creek) / Aminet - June 1993 [Walnut Creek].iso / aminet / dev / c / cformat.lha / CFormat / CFormat.DOC < prev    next >
Text File  |  1992-06-07  |  3KB  |  114 lines
  1.                                     CFormat
  2.                                     =======
  3.  
  4.                               C-Source-Formatter
  5.                               ==================
  6.  
  7.                           (c) 1991 by Rüdiger Dreier
  8.  
  9.                                  Version 3.10
  10.                                  ------------
  11.  
  12. 0. About
  13. ========
  14. CFormat is FREEWARE, you may copy and spread it, as you want, but you MUST NOT
  15. earn any money with it.
  16. If you give this program to someone else, you have to copy the whole drawer,
  17. that means, it must consist of:
  18.  - the source
  19.  - this document
  20.  - a working copy of CFormat
  21.  
  22.      THE AUTHOR  UNDERTAKES  NO  LIABILITY FOR  ANY  DAMAGE CAUSED  BY  THE
  23.      APPROPRIATE OR NOT APPROPRIATE USE OF THIS PROGRAM !
  24.  
  25.      THE AUTHOR  UNDERTAKES  NO LIABILITY  FOR  THE FAULTLESSNESS  OF  THIS
  26.      PROGRAM !
  27.  
  28.      USE IT AT YOUR OWN RISK !
  29.  
  30. If you have hints, bug-reports, criticism, money or PD-soft for me, write to
  31.  
  32.                             Rüdiger Dreier
  33.                             Gustav-Winkler Str. 40
  34.                      W-4800 Bielefeld 18
  35.                             Germany
  36.  
  37. If you want an answer, please add postage !
  38.  
  39. Until end of Oct 92, I can be reached via
  40.  
  41.  uphya600@unibi.hrz.uni-bielefeld.de
  42.  
  43. 1. Introduction
  44. ===============
  45. CFormat is used to format a C-source, so that one can read it better. E.g. you
  46. have the following "program":
  47.  
  48. main(){#ifdef DEBUG
  49. printf("Start\n");
  50. #endif
  51. Testfun(1,2,3,4);
  52. #ifdef DEBUG
  53. printf("End\n");
  54. #endif
  55. }
  56.  
  57. Testfun(LONG i,
  58. int a,
  59. SHORT b,
  60. char c){printf("%ld %d %d %c\n",i,a,b,c);}
  61.  
  62. When you use CFormat, you will get:
  63.  
  64.  main()
  65.   {
  66.    #ifdef DEBUG
  67.    printf("Start\n");
  68. #endif
  69.    Testfun(1,2,3,4);
  70. #ifdef DEBUG
  71.    printf("End\n");
  72. #endif
  73.   }
  74.  
  75.  Testfun(LONG i,
  76.          int a,
  77.          SHORT b,
  78.          char c)
  79.   {
  80.    printf("%ld %d %d %c\n",i,a,b,c);
  81.   }
  82.  
  83. Betterm isn't it ? (It is my favorite way to format as C-source)
  84.  
  85. 2. Using CFormat
  86. ================
  87. CFormat can be used only from CLI. You have two possibilities:
  88.  1. CFormat FROM TO  <RETURN>
  89.  2. CFormat          <RETURN>
  90. If you use the second one, CFormat asks the name of the input and output file.
  91. If there was an I/O error, CFormat tells you >Cannot find file xyz< and quits.
  92. If all worked, CFormat prints
  93.  >Format from FROM to TO<
  94. A bit later, CFormat tells you
  95.  >All ok - no error<
  96. or prints something like:
  97.  
  98. There is an error
  99.  '         : 0
  100.  "         : 0
  101. Comments   : 0
  102.  (..)      : 0
  103.  {..}      : 1
  104.  
  105. That means, there was a { too much in the source. A -1 would mean too less.
  106. In TO is the formatted source (even if there was an error). Without errors, you
  107. can use this file as new sourcefile, after an error you can use it to find the
  108. error. CFormat find missing {} much faster than a C-compiler, so you can use it
  109. even as a precheck.
  110.  
  111.                                   Enjoy it !
  112.  
  113.  
  114.